package edu.arizona.mindseye.event.enums;

public enum EventType {
	/**
	 * MOVIE_LOADED
	 *  Payload:
	 *  	name - the name of the file that we are loading -- relative path.
	 *      width - the width of the images in the movie
	 *      height - the height of the images in the movie
	 *      frames - the number of frames in the movie
	 *      model - the actual model so that if you want to access images you can.
	 */
	MOVIE_LOADED,
	
	/**
	 * SEEK_COMMAND
	 *   Payload:
	 *       index - the frame index to seek to.
	 */
	SEEK_COMMAND,

	/**
	 * MOVE_FRAME_COMMAND
	 *   Payload:
	 *       delta - the number of frames to move.  -- positive for forward, negative for reverse
	 */
	FRAME_DELTA_COMMAND,
	
	/**
	 * MODEL_CHANGED
	 *   Payload:
	 *      model - the actual model.
	 */
	MODEL_CHANGED,
	
	/**
	 * SAVE_SUCCESSFUL
	 *   Payload:
	 */
	SAVE_SUCCESSFUL,
	
	/**
	 * ADD_BEHAVIOR
	 *   Payload:
	 *     name - the name of the behavior
	 */
	ADD_BEHAVIOR, 
	
	/**
	 * BEHAVIORS
	 *   Payload:
	 *      behaviors - the behaviors that are available.
	 */
	BEHAVIORS,
	
	/**
	 * SAVE_ANNOTATIONS
	 *   Payload:
	 *   
	 */
	DO_SAVE_ANNOTATIONS,
	
	/**
	 * ANNOTATIONS
	 *   Payload:
	 *     name - the name of the movie.
	 *     annotation - the list of annotations
	 */
	ANNOTATIONS,
	
	/**
	 * SELECTED_ANNOTATION
	 *   Payload:
	 *     id - the human id
	 *     index - the index of the annotation
	 *     annotation - the annotation that is currently selected
	 */
	SELECTED_ANNOTATION,
}
